pp108 : App Palette

App Palette

  


An App Palette control can be used to load a sub-application in an XForm. An App Palette is an application by itself and is loaded in a region. You can load multiple App Palettes in a region. Multiple App Palettes display as tabs in the region. Clicking a tab displays the respective App Palette. You can drag App Palettes between regions. For information on adding regions to an XForm, see Splitting XForms into Regions.

An App Palette control can be further customized by modifying its property sheet. This control is derived from the AJAX Toolkit library - AppPalette.

Loaded appPalettes can be accessed from the appPalettes collection of the application object. So use the application.appPalettes[apppaletteID] to get the AppPalette application.

For details about the control's behavior and functionality, see AppPalette.

 

Properties, Events, and Methods of the Control


The properties, events, and methods associated with the App Palette control define its behavior. You can set them either through the control's property sheet or programmatically using the APIs. 

The following XForms-related properties and methods are available for the control:

Table 1. List of Properties

Design-time property

Run-time property

Description

ID

  

Sets the string that identifies the control on an XForm. If not specified, a unique ID is automatically generated.

Class Name

className

Sets or retrieves the class name applied on the control.

Resizable

  

Sets the App Palette as resizable at run time.

Content

  

Sets the content that can be added to the App Palette. Options are:

  • Controls: Select to ensure that only controls can be displayed in the App Palette.
  • Application: Select to ensure that only an application can be displayed in the App Palette.

URL

  

Sets the specified application URL to the control. This application is opened in the control on loading. This option is available only when you select Application as content.

Id

  

Sets a unique identifier for the application that is to be opened in the control and for which the URL is specified. This option is available only when you select Application as content.

Caption

  

Denotes the caption of the application. This name will appear in the taskbar as the tab caption. This will also appear as the titlebar text, as a combination of <caption> and <description> if both are different, and <caption> if both are same. This option is available only when you select Application as content.

Description

  

Denotes the description of the application. This name will appear in the titlebar of the application as a combination of <caption> and <description>. This option is available only when you select Application as content.

Region

  

Sets the region of the App Palette in which to load the application URL. in the This option is available only when you select Application as content.

Title Bar

  

Displays a title bar in the App Palette. In case an application is displayed in the App Palette, the title bar is a combination of the Caption and Description, as specified in the application definition.

Store in Preferences

inPreferences

Denotes whether the state of an application in the App Palette is to be saved as a user preference. If set totrue, the application's state is stored and is retained when the application is launched again.

Dockable

  

Denotes whether the App Palette can be docked in the region in which it is located.

Docked

  

Denotes whether the application loaded in the control will be docked when it is first loaded. This option is available only when you select Application as content.

Automatic

  

Retrieves the content of the App Palette from the backend, when the App Palette is first loaded. This option is available only when you select Application as content.To load a Web page faster, you can initially retrieve content for only the controls that display on load, for example, the first tab in a tag group, or the first App Palette in a set of App Palletes. To stop automatic content loading of content for an App Palette, uncheck the Automatic check box.The Automatic check box is selected by default.

Display in view manager

  

Denotes whether the App Palette control will display in the View Manager ( menu in the toolbar of an App Palette ) and enables you to define its appearance. Options are:

  • self: The App Palette will be registered as an option in the View Manager menu.
  • none: The App Palette will not be registered as an option in the View Manager menu.
  • custom: The App Palette will be registered as an option in the View Manager. A separator displays that groups all App Palettes with the same custom group name.

 

Table 2. List of Methods

Method

Description

addListener()

This method registers the control to receive notifications for an event.

removeListener()

This method unregisters the control to cease receiving notifications for its events.